home *** CD-ROM | disk | FTP | other *** search
- /* permutation/gsl_permutation.h
- *
- * Copyright (C) 1996, 1997, 1998, 1999, 2000 Brian Gough
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or (at
- * your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
- #ifndef __GSL_PERMUTATION_H__
- #define __GSL_PERMUTATION_H__
-
- #include <stdlib.h>
- #include <gsl/gsl_errno.h>
-
- #undef __BEGIN_DECLS
- #undef __END_DECLS
- #ifdef __cplusplus
- # define __BEGIN_DECLS extern "C" {
- # define __END_DECLS }
- #else
- # define __BEGIN_DECLS /* empty */
- # define __END_DECLS /* empty */
- #endif
-
- __BEGIN_DECLS
-
- struct gsl_permutation_struct
- {
- size_t size;
- size_t *data;
- };
-
- typedef struct gsl_permutation_struct gsl_permutation;
-
- gsl_permutation *gsl_permutation_alloc (const size_t n);
- gsl_permutation *gsl_permutation_calloc (const size_t n);
- void gsl_permutation_init (gsl_permutation * p);
- void gsl_permutation_free (gsl_permutation * p);
- int gsl_permutation_memcpy (gsl_permutation * dest, const gsl_permutation * src);
-
- int gsl_permutation_fread (FILE * stream, gsl_permutation * p);
- int gsl_permutation_fwrite (FILE * stream, const gsl_permutation * p);
- int gsl_permutation_fscanf (FILE * stream, gsl_permutation * p);
- int gsl_permutation_fprintf (FILE * stream, const gsl_permutation * p, const char *format);
-
- size_t gsl_permutation_size (const gsl_permutation * p);
- size_t * gsl_permutation_data (const gsl_permutation * p);
-
- size_t gsl_permutation_get (const gsl_permutation * p, const size_t i);
- int gsl_permutation_swap (gsl_permutation * p, const size_t i, const size_t j);
-
- int gsl_permutation_valid (gsl_permutation * p);
- void gsl_permutation_reverse (gsl_permutation * p);
- int gsl_permutation_inverse (gsl_permutation * inv, const gsl_permutation * p);
- int gsl_permutation_next (gsl_permutation * p);
- int gsl_permutation_prev (gsl_permutation * p);
-
- #ifdef GSL_EXPORTS
- __declspec(dllexport) int gsl_check_range;
- #elif defined(GSL_IMPORTS)
- __declspec(dllimport) int gsl_check_range;
- #else
- extern int gsl_check_range;
- #endif
-
- #ifdef HAVE_INLINE
-
- extern inline
- size_t
- gsl_permutation_get (const gsl_permutation * p, const size_t i)
- {
- #ifndef GSL_RANGE_CHECK_OFF
- if (i >= p->size)
- {
- GSL_ERROR_VAL ("index out of range", GSL_EINVAL, 0);
- }
- #endif
- return p->data[i];
- }
-
- #endif /* HAVE_INLINE */
-
- __END_DECLS
-
- #endif /* __GSL_PERMUTATION_H__ */
-